/*
 * Copyright (c) 2007-2008, Thomas Krause (tho.krause@gmail.com)
 * 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 *     * Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright notice,
 *       this list of conditions and the following disclaimer in the documentation
 *       and/or other materials provided with the distribution.
 *     * Neither the name of gidoo nor the names of its contributors may be used to
 *       endorse or promote products derived from this software without specific
 *       prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.gidoo.cms.editor.edit;

import org.apache.wicket.markup.html.panel.Panel;

/**
 * This abstract class must be extended by every editor that should be usable
 * within the editor-UI of gidooCMS. <br><br>
 * 
 * <b>IMPORTANT: </b> In order to ease instantiation this class always has an
 * empty constructor. Since this class extends <code>Panel</code> we have to
 * provide a Wicket-ID. The Wicket-ID of this component is always the same
 * and currently it is "<code>gidooCMSEditorComponent</code>".
 * Please notice that it
 * is only possible to have one editor on a page at the same time. 
 * 
 * @author <a href="mailto:tho.krause@gmail.com">Thomas Krause</a>
 */
public abstract class EditorComponent extends Panel
{
  /** The Wicket-ID used by this component.*/
  public static final String wicketID = "gidooCMSEditorComponent";
  
  public EditorComponent()
  {
    super(wicketID);
  }
  
  /** Get the current XML-source as text. */
  abstract public String getText();
  
  /** Set the new XML-source. */
  abstract public void setText(String newText);
    
  /** Returns true if the parent component should provide preview-function. */
  abstract public boolean isPreviewFunctionNeeded();
  
  /** Enable or disable all component belonging to this editor */
  abstract public void enableComponents(boolean enable);
}
